<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GSettings</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GIO Reference Manual">
<link rel="up" href="settings.html" title="Settings">
<link rel="prev" href="settings.html" title="Settings">
<link rel="next" href="GSettingsBackend.html" title="GSettingsBackend">
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="settings.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="settings.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIO Reference Manual</th>
<td><a accesskey="n" href="GSettingsBackend.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GSettings.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GSettings.description" class="shortcut">Description</a>
                   | 
                  <a href="#GSettings.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GSettings.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#GSettings.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GSettings"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GSettings.top_of_page"></a>GSettings</span></h2>
<p>GSettings — High-level API for application settings</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GSettings.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="GSettings.html#GSettings-struct" title="GSettings">GSettings</a>;
<a class="link" href="GSettings.html" title="GSettings"><span class="returnvalue">GSettings</span></a> *              <a class="link" href="GSettings.html#g-settings-new" title="g_settings_new ()">g_settings_new</a>                 (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *schema</code></em>);
<a class="link" href="GSettings.html" title="GSettings"><span class="returnvalue">GSettings</span></a> *              <a class="link" href="GSettings.html#g-settings-new-with-path" title="g_settings_new_with_path ()">g_settings_new_with_path</a>       (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *schema</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);
<a class="link" href="GSettings.html" title="GSettings"><span class="returnvalue">GSettings</span></a> *              <a class="link" href="GSettings.html#g-settings-new-with-backend" title="g_settings_new_with_backend ()">g_settings_new_with_backend</a>    (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *schema</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GSettingsBackend.html" title="GSettingsBackend"><span class="type">GSettingsBackend</span></a> *backend</code></em>);
<a class="link" href="GSettings.html" title="GSettings"><span class="returnvalue">GSettings</span></a> *              <a class="link" href="GSettings.html#g-settings-new-with-backend-and-path" title="g_settings_new_with_backend_and_path ()">g_settings_new_with_backend_and_path</a>
                                                        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *schema</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GSettingsBackend.html" title="GSettingsBackend"><span class="type">GSettingsBackend</span></a> *backend</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GSettings.html#g-settings-sync" title="g_settings_sync ()">g_settings_sync</a>                     (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *               <a class="link" href="GSettings.html#g-settings-get-value" title="g_settings_get_value ()">g_settings_get_value</a>           (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSettings.html#g-settings-set-value" title="g_settings_set_value ()">g_settings_set_value</a>                (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSettings.html#g-settings-is-writable" title="g_settings_is_writable ()">g_settings_is_writable</a>              (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GSettings.html#g-settings-delay" title="g_settings_delay ()">g_settings_delay</a>                    (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GSettings.html#g-settings-apply" title="g_settings_apply ()">g_settings_apply</a>                    (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GSettings.html#g-settings-revert" title="g_settings_revert ()">g_settings_revert</a>                   (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSettings.html#g-settings-get-has-unapplied" title="g_settings_get_has_unapplied ()">g_settings_get_has_unapplied</a>        (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>);
<a class="link" href="GSettings.html" title="GSettings"><span class="returnvalue">GSettings</span></a> *              <a class="link" href="GSettings.html#g-settings-get-child" title="g_settings_get_child ()">g_settings_get_child</a>           (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GSettings.html#g-settings-reset" title="g_settings_reset ()">g_settings_reset</a>                    (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);

const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * const * <a class="link" href="GSettings.html#g-settings-list-schemas" title="g_settings_list_schemas ()">g_settings_list_schemas</a>           (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * const * <a class="link" href="GSettings.html#g-settings-list-relocatable-schemas" title="g_settings_list_relocatable_schemas ()">g_settings_list_relocatable_schemas</a>
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **                 <a class="link" href="GSettings.html#g-settings-list-keys" title="g_settings_list_keys ()">g_settings_list_keys</a>           (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **                 <a class="link" href="GSettings.html#g-settings-list-children" title="g_settings_list_children ()">g_settings_list_children</a>       (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *               <a class="link" href="GSettings.html#g-settings-get-range" title="g_settings_get_range ()">g_settings_get_range</a>           (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSettings.html#g-settings-range-check" title="g_settings_range_check ()">g_settings_range_check</a>              (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>);

<span class="returnvalue">void</span>                <a class="link" href="GSettings.html#g-settings-get" title="g_settings_get ()">g_settings_get</a>                      (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
                                                         <em class="parameter"><code>...</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSettings.html#g-settings-set" title="g_settings_set ()">g_settings_set</a>                      (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
                                                         <em class="parameter"><code>...</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSettings.html#g-settings-get-boolean" title="g_settings_get_boolean ()">g_settings_get_boolean</a>              (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSettings.html#g-settings-set-boolean" title="g_settings_set_boolean ()">g_settings_set_boolean</a>              (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="GSettings.html#g-settings-get-int" title="g_settings_get_int ()">g_settings_get_int</a>                  (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSettings.html#g-settings-set-int" title="g_settings_set_int ()">g_settings_set_int</a>                  (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="GSettings.html#g-settings-get-double" title="g_settings_get_double ()">g_settings_get_double</a>               (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSettings.html#g-settings-set-double" title="g_settings_set_double ()">g_settings_set_double</a>               (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> value</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *                  <a class="link" href="GSettings.html#g-settings-get-string" title="g_settings_get_string ()">g_settings_get_string</a>          (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSettings.html#g-settings-set-string" title="g_settings_set_string ()">g_settings_set_string</a>               (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **                 <a class="link" href="GSettings.html#g-settings-get-strv" title="g_settings_get_strv ()">g_settings_get_strv</a>            (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSettings.html#g-settings-set-strv" title="g_settings_set_strv ()">g_settings_set_strv</a>                 (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *const *value</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="GSettings.html#g-settings-get-enum" title="g_settings_get_enum ()">g_settings_get_enum</a>                 (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSettings.html#g-settings-set-enum" title="g_settings_set_enum ()">g_settings_set_enum</a>                 (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="GSettings.html#g-settings-get-flags" title="g_settings_get_flags ()">g_settings_get_flags</a>                (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GSettings.html#g-settings-set-flags" title="g_settings_set_flags ()">g_settings_set_flags</a>                (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> value</code></em>);

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (<a class="link" href="GSettings.html#GSettingsGetMapping" title="GSettingsGetMapping ()">*GSettingsGetMapping</a>)              (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *result</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>            <a class="link" href="GSettings.html#g-settings-get-mapped" title="g_settings_get_mapped ()">g_settings_get_mapped</a>               (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GSettings.html#GSettingsGetMapping" title="GSettingsGetMapping ()"><span class="type">GSettingsGetMapping</span></a> mapping</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);

enum                <a class="link" href="GSettings.html#GSettingsBindFlags" title="enum GSettingsBindFlags">GSettingsBindFlags</a>;
<span class="returnvalue">void</span>                <a class="link" href="GSettings.html#g-settings-bind" title="g_settings_bind ()">g_settings_bind</a>                     (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> object</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GSettings.html#GSettingsBindFlags" title="enum GSettingsBindFlags"><span class="type">GSettingsBindFlags</span></a> flags</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GSettings.html#g-settings-bind-with-mapping" title="g_settings_bind_with_mapping ()">g_settings_bind_with_mapping</a>        (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> object</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GSettings.html#GSettingsBindFlags" title="enum GSettingsBindFlags"><span class="type">GSettingsBindFlags</span></a> flags</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GSettings.html#GSettingsBindGetMapping" title="GSettingsBindGetMapping ()"><span class="type">GSettingsBindGetMapping</span></a> get_mapping</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GSettings.html#GSettingsBindSetMapping" title="GSettingsBindSetMapping ()"><span class="type">GSettingsBindSetMapping</span></a> set_mapping</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GSettings.html#g-settings-bind-writable" title="g_settings_bind_writable ()">g_settings_bind_writable</a>            (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> object</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> inverted</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GSettings.html#g-settings-unbind" title="g_settings_unbind ()">g_settings_unbind</a>                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> object</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *          (<a class="link" href="GSettings.html#GSettingsBindSetMapping" title="GSettingsBindSetMapping ()">*GSettingsBindSetMapping</a>)          (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType"><span class="type">GVariantType</span></a> *expected_type</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (<a class="link" href="GSettings.html#GSettingsBindGetMapping" title="GSettingsBindGetMapping ()">*GSettingsBindGetMapping</a>)          (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GSettings.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----GSettings
</pre>
</div>
<div class="refsect1">
<a name="GSettings.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GSettings.html#GSettings--backend" title='The "backend" property'>backend</a>"                  <a class="link" href="GSettingsBackend.html" title="GSettingsBackend"><span class="type">GSettingsBackend</span></a>*     : Read / Write / Construct Only
  "<a class="link" href="GSettings.html#GSettings--delay-apply" title='The "delay-apply" property'>delay-apply</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read
  "<a class="link" href="GSettings.html#GSettings--has-unapplied" title='The "has-unapplied" property'>has-unapplied</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read
  "<a class="link" href="GSettings.html#GSettings--path" title='The "path" property'>path</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
  "<a class="link" href="GSettings.html#GSettings--schema" title='The "schema" property'>schema</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="GSettings.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="GSettings.html#GSettings-change-event" title='The "change-event" signal'>change-event</a>"                                   : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  "<a class="link" href="GSettings.html#GSettings-changed" title='The "changed" signal'>changed</a>"                                        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a>
  "<a class="link" href="GSettings.html#GSettings-writable-change-event" title='The "writable-change-event" signal'>writable-change-event</a>"                          : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  "<a class="link" href="GSettings.html#GSettings-writable-changed" title='The "writable-changed" signal'>writable-changed</a>"                               : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GSettings.description"></a><h2>Description</h2>
<p>
The <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> class provides a convenient API for storing and retrieving
application settings.
</p>
<p>
Reads and writes can be considered to be non-blocking.  Reading
settings with <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> is typically extremely fast: on
approximately the same order of magnitude (but slower than) a
<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> lookup.  Writing settings is also extremely fast in terms
of time to return to your application, but can be extremely expensive
for other threads and other processes.  Many settings backends
(including dconf) have lazy initialisation which means in the common
case of the user using their computer without modifying any settings
a lot of work can be avoided.  For dconf, the D-Bus service doesn't
even need to be started in this case.  For this reason, you should
only ever modify <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> keys in response to explicit user action.
Particular care should be paid to ensure that modifications are not
made during startup -- for example, when settings the initial value
of preferences widgets.  The built-in <a class="link" href="GSettings.html#g-settings-bind" title="g_settings_bind ()"><code class="function">g_settings_bind()</code></a> functionality
is careful not to write settings in response to notify signals as a
result of modifications that it makes to widgets.
</p>
<p>
When creating a GSettings instance, you have to specify a schema
that describes the keys in your settings and their types and default
values, as well as some other information.
</p>
<p>
Normally, a schema has as fixed path that determines where the settings
are stored in the conceptual global tree of settings. However, schemas
can also be 'relocatable', i.e. not equipped with a fixed path. This is
useful e.g. when the schema describes an 'account', and you want to be
able to store a arbitrary number of accounts.
</p>
<p>
Unlike other configuration systems (like GConf), GSettings does not
restrict keys to basic types like strings and numbers. GSettings stores
values as <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>, and allows any <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType"><span class="type">GVariantType</span></a> for keys. Key names
are restricted to lowercase characters, numbers and '-'. Furthermore,
the names must begin with a lowercase character, must not end
with a '-', and must not contain consecutive dashes. Key names can
be up to 32 characters long.
</p>
<p>
Similar to GConf, the default values in GSettings schemas can be
localized, but the localized values are stored in gettext catalogs
and looked up with the domain that is specified in the
<code class="sgmltag-attribute">gettext-domain</code> attribute of the
<code class="sgmltag-starttag">&lt;schemalist&gt;</code> or <code class="sgmltag-starttag">&lt;schema&gt;</code>
elements and the category that is specified in the l10n attribute of the
<code class="sgmltag-starttag">&lt;key&gt;</code> element.
</p>
<p>
GSettings uses schemas in a compact binary form that is created
by the <a href="glib-compile-schemas.html">glib-compile-schemas</a>
utility. The input is a schema description in an XML format that can be
described by the following DTD:
</p>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="symbol">&lt;!</span><span class="usertype">ELEMENT</span><span class="normal"> </span><span class="function">schemalist</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">schema</span><span class="symbol">|</span><span class="keyword">enum</span><span class="symbol">)*</span><span class="normal"> </span><span class="symbol">&gt;</span>
<span class="symbol">&lt;!</span><span class="normal">ATTLIST </span><span class="usertype">schemalist</span><span class="normal"> gettext</span><span class="symbol">-</span><span class="normal">domain #IMPLIED </span><span class="symbol">&gt;</span>

<span class="symbol">&lt;!</span><span class="usertype">ELEMENT</span><span class="normal"> </span><span class="function">schema</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">key</span><span class="symbol">|</span><span class="normal">child</span><span class="symbol">|</span><span class="normal">override</span><span class="symbol">)*</span><span class="normal"> </span><span class="symbol">&gt;</span>
<span class="symbol">&lt;!</span><span class="normal">ATTLIST schema </span><span class="usertype">id</span><span class="normal">             CDATA #REQUIRED</span>
<span class="normal">                 </span><span class="usertype">path</span><span class="normal">           CDATA #IMPLIED</span>
<span class="normal">                 gettext</span><span class="symbol">-</span><span class="usertype">domain</span><span class="normal"> CDATA #IMPLIED</span>
<span class="normal">                 </span><span class="usertype">extends</span><span class="normal">        CDATA #IMPLIED</span>
<span class="normal">                 list</span><span class="symbol">-</span><span class="usertype">of</span><span class="normal">        CDATA #IMPLIED </span><span class="symbol">&gt;</span>

<span class="symbol">&lt;!--</span><span class="normal"> enumerated and </span><span class="usertype">flags</span><span class="normal"> types </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!--</span><span class="normal"> each value element maps a nick to a </span><span class="usertype">numeric</span><span class="normal"> value </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!</span><span class="usertype">ELEMENT</span><span class="normal"> </span><span class="keyword">enum</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">value</span><span class="symbol">*)</span><span class="normal"> </span><span class="symbol">&gt;</span>
<span class="symbol">&lt;!</span><span class="normal">ATTLIST </span><span class="keyword">enum</span><span class="normal"> </span><span class="usertype">id</span><span class="normal"> CDATA #REQUIRED </span><span class="symbol">&gt;</span>

<span class="symbol">&lt;!</span><span class="usertype">ELEMENT</span><span class="normal"> </span><span class="function">flags</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">value</span><span class="symbol">*)</span><span class="normal"> </span><span class="symbol">&gt;</span>
<span class="symbol">&lt;!</span><span class="normal">ATTLIST flags </span><span class="usertype">id</span><span class="normal"> CDATA #REQUIRED </span><span class="symbol">&gt;</span>

<span class="symbol">&lt;!</span><span class="normal">ELEMENT </span><span class="usertype">value</span><span class="normal"> EMPTY </span><span class="symbol">&gt;</span>
<span class="symbol">&lt;!--</span><span class="normal"> nick must be at least </span><span class="number">2</span><span class="normal"> </span><span class="usertype">characters</span><span class="normal"> </span><span class="type">long</span><span class="normal"> </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!--</span><span class="normal"> value must be parsable as a </span><span class="number">32</span><span class="symbol">-</span><span class="usertype">bit</span><span class="normal"> integer </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!</span><span class="normal">ELEMENT </span><span class="usertype">value</span><span class="normal"> nick  #REQUIRED</span>
<span class="normal">                value #REQUIRED </span><span class="symbol">&gt;</span>

<span class="symbol">&lt;!</span><span class="usertype">ELEMENT</span><span class="normal"> </span><span class="function">key</span><span class="normal"> </span><span class="symbol">(</span><span class="keyword">default</span><span class="symbol">|</span><span class="normal">summary</span><span class="symbol">?|</span><span class="normal">description</span><span class="symbol">?|</span><span class="normal">range</span><span class="symbol">?|</span><span class="normal">choices</span><span class="symbol">?|</span><span class="normal">aliases</span><span class="symbol">?)</span><span class="normal"> </span><span class="symbol">&gt;</span>
<span class="symbol">&lt;!--</span><span class="normal"> name can only contain </span><span class="usertype">lowercase</span><span class="normal"> letters</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">numbers</span><span class="normal"> and </span><span class="string">'-'</span><span class="normal"> </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!--</span><span class="normal"> type must be a GVariant </span><span class="usertype">type</span><span class="normal"> string </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!--</span><span class="normal"> </span><span class="keyword">enum</span><span class="normal"> must be the id of an </span><span class="keyword">enum</span><span class="normal"> type that has been </span><span class="usertype">defined</span><span class="normal"> earlier </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!--</span><span class="normal"> flags must be the id of a flags type that has been </span><span class="usertype">defined</span><span class="normal"> earlier </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!--</span><span class="normal"> exactly one </span><span class="usertype">of</span><span class="normal"> type</span><span class="symbol">,</span><span class="normal"> </span><span class="keyword">enum</span><span class="normal"> or flags must </span><span class="usertype">be</span><span class="normal"> given </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!</span><span class="normal">ATTLIST key </span><span class="usertype">name</span><span class="normal">  CDATA #REQUIRED</span>
<span class="normal">              </span><span class="usertype">type</span><span class="normal">  CDATA #IMPLIED</span>
<span class="normal">              </span><span class="keyword">enum</span><span class="normal">  CDATA #IMPLIED</span>
<span class="normal">              </span><span class="usertype">flags</span><span class="normal"> CDATA #IMPLIED </span><span class="symbol">&gt;</span>

<span class="symbol">&lt;!--</span><span class="normal"> the </span><span class="keyword">default</span><span class="normal"> value is specified a a </span><span class="usertype">serialized</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant">GVariant</a></span><span class="symbol">,</span>
<span class="normal">     i</span><span class="symbol">.</span><span class="normal">e</span><span class="symbol">.</span><span class="normal"> you have to include the quotes when specifying </span><span class="usertype">a</span><span class="normal"> string </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!</span><span class="usertype">ELEMENT</span><span class="normal"> </span><span class="keyword">default</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">#PCDATA</span><span class="symbol">)</span><span class="normal"> </span><span class="symbol">&gt;</span>
<span class="symbol">&lt;!--</span><span class="normal"> the presence of the l10n attribute marks a </span><span class="keyword">default</span><span class="normal"> value </span><span class="keyword">for</span>
<span class="normal">     translation</span><span class="symbol">,</span><span class="normal"> its value is the gettext category </span><span class="usertype">to</span><span class="normal"> use </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!--</span><span class="normal"> </span><span class="keyword">if</span><span class="normal"> context </span><span class="usertype">is</span><span class="normal"> present</span><span class="symbol">,</span><span class="normal"> it specifies msgctxt </span><span class="usertype">to</span><span class="normal"> use </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!</span><span class="normal">ATTLIST </span><span class="usertype">default</span><span class="normal"> </span><span class="function">l10n</span><span class="normal">    </span><span class="symbol">(</span><span class="normal">messages</span><span class="symbol">|</span><span class="normal">time</span><span class="symbol">)</span><span class="normal"> #IMPLIED</span>
<span class="normal">                  </span><span class="usertype">context</span><span class="normal"> CDATA           #IMPLIED </span><span class="symbol">&gt;</span>

<span class="symbol">&lt;!</span><span class="usertype">ELEMENT</span><span class="normal"> </span><span class="function">summary</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">#PCDATA</span><span class="symbol">)</span><span class="normal"> </span><span class="symbol">&gt;</span>
<span class="symbol">&lt;!</span><span class="usertype">ELEMENT</span><span class="normal"> </span><span class="function">description</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">#PCDATA</span><span class="symbol">)</span><span class="normal"> </span><span class="symbol">&gt;</span>

<span class="symbol">&lt;!--</span><span class="normal"> range is only allowed </span><span class="keyword">for</span><span class="normal"> keys with </span><span class="usertype">numeric</span><span class="normal"> type </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!</span><span class="normal">ELEMENT </span><span class="usertype">range</span><span class="normal"> EMPTY </span><span class="symbol">&gt;</span>
<span class="symbol">&lt;!--</span><span class="normal"> min and max must be parseable as values of the key type </span><span class="usertype">and</span><span class="normal"> min </span><span class="symbol">&lt;</span><span class="normal"> max </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!</span><span class="normal">ATTLIST range </span><span class="usertype">min</span><span class="normal"> CDATA #REQUIRED</span>
<span class="normal">                </span><span class="usertype">max</span><span class="normal"> CDATA #REQUIRED </span><span class="symbol">&gt;</span>

<span class="symbol">&lt;!--</span><span class="normal"> choices is only allowed </span><span class="keyword">for</span><span class="normal"> keys with string or string </span><span class="usertype">array</span><span class="normal"> type </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!</span><span class="usertype">ELEMENT</span><span class="normal"> </span><span class="function">choices</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">choice</span><span class="symbol">+)</span><span class="normal"> </span><span class="symbol">&gt;</span>
<span class="symbol">&lt;!--</span><span class="normal"> each choice element specifies one </span><span class="usertype">possible</span><span class="normal"> value </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!</span><span class="normal">ELEMENT </span><span class="usertype">choice</span><span class="normal"> EMPTY </span><span class="symbol">&gt;</span>
<span class="symbol">&lt;!</span><span class="normal">ATTLIST choice </span><span class="usertype">value</span><span class="normal"> CDATA #REQUIRED </span><span class="symbol">&gt;</span>

<span class="symbol">&lt;!--</span><span class="normal"> aliases is only allowed </span><span class="keyword">for</span><span class="normal"> keys with enumerated type or </span><span class="usertype">with</span><span class="normal"> choices </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!</span><span class="usertype">ELEMENT</span><span class="normal"> </span><span class="function">aliases</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">alias</span><span class="symbol">+)</span><span class="normal"> </span><span class="symbol">&gt;</span>
<span class="symbol">&lt;!--</span><span class="normal"> each alias element specifies an alias </span><span class="keyword">for</span><span class="normal"> one of the </span><span class="usertype">possible</span><span class="normal"> values </span><span class="symbol">--&gt;</span>
<span class="symbol">&lt;!</span><span class="normal">ELEMENT </span><span class="usertype">alias</span><span class="normal"> EMPTY </span><span class="symbol">&gt;</span>
<span class="symbol">&lt;!</span><span class="normal">ATTLIST alias </span><span class="usertype">value</span><span class="normal"> CDATA #REQUIRED </span><span class="symbol">&gt;</span>

<span class="symbol">&lt;!</span><span class="normal">ELEMENT </span><span class="usertype">child</span><span class="normal"> EMPTY </span><span class="symbol">&gt;</span>
<span class="symbol">&lt;!</span><span class="normal">ATTLIST child </span><span class="usertype">name</span><span class="normal">   CDATA #REQUIRED</span>
<span class="normal">                </span><span class="usertype">schema</span><span class="normal"> CDATA #REQUIRED </span><span class="symbol">&gt;</span>

<span class="symbol">&lt;!</span><span class="usertype">ELEMENT</span><span class="normal"> </span><span class="function">override</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">#PCDATA</span><span class="symbol">)</span><span class="normal"> </span><span class="symbol">&gt;</span>
<span class="symbol">&lt;!</span><span class="normal">ATTLIST override </span><span class="usertype">name</span><span class="normal">    CDATA #REQUIRED</span>
<span class="normal">                   </span><span class="usertype">l10n</span><span class="normal">    CDATA #IMPLIED</span>
<span class="normal">                   </span><span class="usertype">context</span><span class="normal"> CDATA #IMPLIED </span><span class="symbol">&gt;</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p>
</p>
<p>
glib-compile-schemas expects schema files to have the extension <code class="filename">.gschema.xml</code>
</p>
<p>
At runtime, schemas are identified by their id (as specified
in the <code class="sgmltag-attribute">id</code> attribute of the
<code class="sgmltag-starttag">&lt;schema&gt;</code> element). The
convention for schema ids is to use a dotted name, similar in
style to a D-Bus bus name, e.g. "org.gnome.SessionManager". In particular,
if the settings are for a specific service that owns a D-Bus bus name,
the D-Bus bus name and schema id should match. For schemas which deal
with settings not associated with one named application, the id should
not use StudlyCaps, e.g. "org.gnome.font-rendering".
</p>
<p>
In addition to <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> types, keys can have types that have enumerated
types. These can be described by a <code class="sgmltag-starttag">&lt;choice&gt;</code>,
<code class="sgmltag-starttag">&lt;enum&gt;</code> or <code class="sgmltag-starttag">&lt;flags&gt;</code> element, see
<a class="xref" href="GSettings.html#schema-enumerated" title="Example 12. Ranges, choices and enumerated types">Example 12, “Ranges, choices and enumerated types”</a>. The underlying type of
such a key is string, but you can use <a class="link" href="GSettings.html#g-settings-get-enum" title="g_settings_get_enum ()"><code class="function">g_settings_get_enum()</code></a>,
<a class="link" href="GSettings.html#g-settings-set-enum" title="g_settings_set_enum ()"><code class="function">g_settings_set_enum()</code></a>, <a class="link" href="GSettings.html#g-settings-get-flags" title="g_settings_get_flags ()"><code class="function">g_settings_get_flags()</code></a>, <a class="link" href="GSettings.html#g-settings-set-flags" title="g_settings_set_flags ()"><code class="function">g_settings_set_flags()</code></a>
access the numeric values corresponding to the string value of enum
and flags keys.
</p>
<p>
</p>
<div class="example">
<a name="schema-default-values"></a><p class="title"><b>Example 11. Default values</b></p>
<div class="example-contents">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="symbol">&lt;</span><span class="normal">schemalist</span><span class="symbol">&gt;</span>
<span class="normal">  </span><span class="symbol">&lt;</span><span class="usertype">schema</span><span class="normal"> id</span><span class="symbol">=</span><span class="string">"org.gtk.Test"</span><span class="normal"> path</span><span class="symbol">=</span><span class="string">"/tests/"</span><span class="normal"> gettext</span><span class="symbol">-</span><span class="normal">domain</span><span class="symbol">=</span><span class="string">"test"</span><span class="symbol">&gt;</span>

<span class="normal">    </span><span class="symbol">&lt;</span><span class="usertype">key</span><span class="normal"> name</span><span class="symbol">=</span><span class="string">"greeting"</span><span class="normal"> type</span><span class="symbol">=</span><span class="string">"s"</span><span class="symbol">&gt;</span>
<span class="normal">      </span><span class="symbol">&lt;</span><span class="keyword">default</span><span class="normal"> l10n</span><span class="symbol">=</span><span class="string">"messages"</span><span class="symbol">&gt;</span><span class="string">"Hello, earthlings"</span><span class="symbol">&lt;/</span><span class="keyword">default</span><span class="symbol">&gt;</span>
<span class="normal">      </span><span class="symbol">&lt;</span><span class="normal">summary</span><span class="symbol">&gt;</span><span class="usertype">A</span><span class="normal"> greeting</span><span class="symbol">&lt;/</span><span class="normal">summary</span><span class="symbol">&gt;</span>
<span class="normal">      </span><span class="symbol">&lt;</span><span class="normal">description</span><span class="symbol">&gt;</span>
<span class="normal">        Greeting of the invading martians</span>
<span class="normal">      </span><span class="symbol">&lt;/</span><span class="normal">description</span><span class="symbol">&gt;</span>
<span class="normal">    </span><span class="symbol">&lt;/</span><span class="normal">key</span><span class="symbol">&gt;</span>

<span class="normal">    </span><span class="symbol">&lt;</span><span class="usertype">key</span><span class="normal"> name</span><span class="symbol">=</span><span class="string">"box"</span><span class="normal"> type</span><span class="symbol">=</span><span class="string">"(ii)"</span><span class="symbol">&gt;</span>
<span class="normal">      </span><span class="symbol">&lt;</span><span class="keyword">default</span><span class="symbol">&gt;(</span><span class="number">20</span><span class="symbol">,</span><span class="number">30</span><span class="symbol">)&lt;/</span><span class="keyword">default</span><span class="symbol">&gt;</span>
<span class="normal">    </span><span class="symbol">&lt;/</span><span class="normal">key</span><span class="symbol">&gt;</span>

<span class="normal">  </span><span class="symbol">&lt;/</span><span class="normal">schema</span><span class="symbol">&gt;</span>
<span class="symbol">&lt;/</span><span class="normal">schemalist</span><span class="symbol">&gt;</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<p><br class="example-break">
</p>
<p>
</p>
<div class="example">
<a name="schema-enumerated"></a><p class="title"><b>Example 12. Ranges, choices and enumerated types</b></p>
<div class="example-contents">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="symbol">&lt;</span><span class="normal">schemalist</span><span class="symbol">&gt;</span>

<span class="normal">  </span><span class="symbol">&lt;</span><span class="keyword">enum</span><span class="normal"> id</span><span class="symbol">=</span><span class="string">"myenum"</span><span class="symbol">&gt;</span>
<span class="normal">    </span><span class="symbol">&lt;</span><span class="usertype">value</span><span class="normal"> nick</span><span class="symbol">=</span><span class="string">"first"</span><span class="normal"> value</span><span class="symbol">=</span><span class="string">"1"</span><span class="symbol">/&gt;</span>
<span class="normal">    </span><span class="symbol">&lt;</span><span class="usertype">value</span><span class="normal"> nick</span><span class="symbol">=</span><span class="string">"second"</span><span class="normal"> value</span><span class="symbol">=</span><span class="string">"2"</span><span class="symbol">/&gt;</span>
<span class="normal">  </span><span class="symbol">&lt;/</span><span class="keyword">enum</span><span class="symbol">&gt;</span>

<span class="normal">  </span><span class="symbol">&lt;</span><span class="keyword">enum</span><span class="normal"> id</span><span class="symbol">=</span><span class="string">"myflags"</span><span class="symbol">&gt;</span>
<span class="normal">    </span><span class="symbol">&lt;</span><span class="usertype">value</span><span class="normal"> nick</span><span class="symbol">=</span><span class="string">"flag1"</span><span class="normal"> value</span><span class="symbol">=</span><span class="string">"1"</span><span class="symbol">/&gt;</span>
<span class="normal">    </span><span class="symbol">&lt;</span><span class="usertype">value</span><span class="normal"> nick</span><span class="symbol">=</span><span class="string">"flag2"</span><span class="normal"> value</span><span class="symbol">=</span><span class="string">"2"</span><span class="symbol">/&gt;</span>
<span class="normal">    </span><span class="symbol">&lt;</span><span class="usertype">value</span><span class="normal"> nick</span><span class="symbol">=</span><span class="string">"flag3"</span><span class="normal"> value</span><span class="symbol">=</span><span class="string">"4"</span><span class="symbol">/&gt;</span>
<span class="normal">  </span><span class="symbol">&lt;/</span><span class="keyword">enum</span><span class="symbol">&gt;</span>

<span class="normal">  </span><span class="symbol">&lt;</span><span class="usertype">schema</span><span class="normal"> id</span><span class="symbol">=</span><span class="string">"org.gtk.Test"</span><span class="symbol">&gt;</span>

<span class="normal">    </span><span class="symbol">&lt;</span><span class="usertype">key</span><span class="normal"> name</span><span class="symbol">=</span><span class="string">"key-with-range"</span><span class="normal"> type</span><span class="symbol">=</span><span class="string">"i"</span><span class="symbol">&gt;</span>
<span class="normal">      </span><span class="symbol">&lt;</span><span class="usertype">range</span><span class="normal"> min</span><span class="symbol">=</span><span class="string">"1"</span><span class="normal"> max</span><span class="symbol">=</span><span class="string">"100"</span><span class="symbol">/&gt;</span>
<span class="normal">      </span><span class="symbol">&lt;</span><span class="keyword">default</span><span class="symbol">&gt;</span><span class="number">10</span><span class="symbol">&lt;/</span><span class="keyword">default</span><span class="symbol">&gt;</span>
<span class="normal">    </span><span class="symbol">&lt;/</span><span class="normal">key</span><span class="symbol">&gt;</span>

<span class="normal">    </span><span class="symbol">&lt;</span><span class="usertype">key</span><span class="normal"> name</span><span class="symbol">=</span><span class="string">"key-with-choices"</span><span class="normal"> type</span><span class="symbol">=</span><span class="string">"s"</span><span class="symbol">&gt;</span>
<span class="normal">      </span><span class="symbol">&lt;</span><span class="normal">choices</span><span class="symbol">&gt;</span>
<span class="normal">        </span><span class="symbol">&lt;</span><span class="usertype">choice</span><span class="normal"> value</span><span class="symbol">=</span><span class="string">'Elisabeth'</span><span class="symbol">/&gt;</span>
<span class="normal">        </span><span class="symbol">&lt;</span><span class="usertype">choice</span><span class="normal"> value</span><span class="symbol">=</span><span class="string">'Annabeth'</span><span class="symbol">/&gt;</span>
<span class="normal">        </span><span class="symbol">&lt;</span><span class="usertype">choice</span><span class="normal"> value</span><span class="symbol">=</span><span class="string">'Joe'</span><span class="symbol">/&gt;</span>
<span class="normal">      </span><span class="symbol">&lt;/</span><span class="normal">choices</span><span class="symbol">&gt;</span>
<span class="normal">      </span><span class="symbol">&lt;</span><span class="normal">aliases</span><span class="symbol">&gt;</span>
<span class="normal">        </span><span class="symbol">&lt;</span><span class="usertype">alias</span><span class="normal"> value</span><span class="symbol">=</span><span class="string">'Anna'</span><span class="normal"> target</span><span class="symbol">=</span><span class="string">'Annabeth'</span><span class="symbol">/&gt;</span>
<span class="normal">        </span><span class="symbol">&lt;</span><span class="usertype">alias</span><span class="normal"> value</span><span class="symbol">=</span><span class="string">'Beth'</span><span class="normal"> target</span><span class="symbol">=</span><span class="string">'Elisabeth'</span><span class="symbol">/&gt;</span>
<span class="normal">      </span><span class="symbol">&lt;/</span><span class="normal">aliases</span><span class="symbol">&gt;</span>
<span class="normal">      </span><span class="symbol">&lt;</span><span class="keyword">default</span><span class="symbol">&gt;</span><span class="string">'Joe'</span><span class="symbol">&lt;/</span><span class="keyword">default</span><span class="symbol">&gt;</span>
<span class="normal">    </span><span class="symbol">&lt;/</span><span class="normal">key</span><span class="symbol">&gt;</span>

<span class="normal">    </span><span class="symbol">&lt;</span><span class="usertype">key</span><span class="normal"> name</span><span class="symbol">=</span><span class="string">'enumerated-key'</span><span class="normal"> </span><span class="keyword">enum</span><span class="symbol">=</span><span class="string">'myenum'</span><span class="symbol">&gt;</span>
<span class="normal">      </span><span class="symbol">&lt;</span><span class="keyword">default</span><span class="symbol">&gt;</span><span class="string">'first'</span><span class="symbol">&lt;/</span><span class="keyword">default</span><span class="symbol">&gt;</span>
<span class="normal">    </span><span class="symbol">&lt;/</span><span class="normal">key</span><span class="symbol">&gt;</span>

<span class="normal">    </span><span class="symbol">&lt;</span><span class="usertype">key</span><span class="normal"> name</span><span class="symbol">=</span><span class="string">'flags-key'</span><span class="normal"> flags</span><span class="symbol">=</span><span class="string">'myflags'</span><span class="symbol">&gt;</span>
<span class="normal">      </span><span class="symbol">&lt;</span><span class="keyword">default</span><span class="symbol">&gt;[</span><span class="string">"flag1"</span><span class="symbol">,</span><span class="normal">flag2</span><span class="string">"]&lt;/default&gt;</span>
<span class="string">    &lt;/key&gt;</span>
<span class="string">  &lt;/schema&gt;</span>
<span class="string">&lt;/schemalist&gt;</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<p><br class="example-break">
</p>
<p>
</p>
<div class="refsect2">
<a name="id718774"></a><h3>Vendor overrides</h3>
<p>
    Default values are defined in the schemas that get installed by
    an application. Sometimes, it is necessary for a vendor or distributor
    to adjust these defaults. Since patching the XML source for the schema
    is inconvenient and error-prone,
    <a href="glib-compile-schemas.html">glib-compile-schemas</a> reads
    so-called 'vendor override' files. These are keyfiles in the same
    directory as the XML schema sources which can override default values.
    The schema id serves as the group name in the key file, and the values
    are expected in serialized GVariant form, as in the following example:
    </p>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="symbol">[</span><span class="normal">org</span><span class="symbol">.</span><span class="normal">gtk</span><span class="symbol">.</span><span class="normal">Example</span><span class="symbol">]</span>
<span class="normal">key1</span><span class="symbol">=</span><span class="string">'string'</span>
<span class="normal">key2</span><span class="symbol">=</span><span class="number">1.5</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p>
  </p>
<p>
    glib-compile-schemas expects schema files to have the extension
    <code class="filename">.gschema.override</code>
  </p>
</div>
<p>
</p>
<p>
</p>
<div class="refsect2">
<a name="id718818"></a><h3>Binding</h3>
<p>
    A very convenient feature of GSettings lets you bind <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> properties
    directly to settings, using <a class="link" href="GSettings.html#g-settings-bind" title="g_settings_bind ()"><code class="function">g_settings_bind()</code></a>. Once a GObject property
    has been bound to a setting, changes on either side are automatically
    propagated to the other side. GSettings handles details like
    mapping between GObject and GVariant types, and preventing infinite
    cycles.
  </p>
<p>
    This makes it very easy to hook up a preferences dialog to the
    underlying settings. To make this even more convenient, GSettings
    looks for a boolean property with the name "sensitivity" and
    automatically binds it to the writability of the bound setting.
    If this 'magic' gets in the way, it can be suppressed with the
    <a class="link" href="GSettings.html#G-SETTINGS-BIND-NO-SENSITIVITY:CAPS"><span class="type">G_SETTINGS_BIND_NO_SENSITIVITY</span></a> flag.
  </p>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="GSettings.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GSettings-struct"></a><h3>GSettings</h3>
<pre class="programlisting">typedef struct _GSettings GSettings;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-new"></a><h3>g_settings_new ()</h3>
<pre class="programlisting"><a class="link" href="GSettings.html" title="GSettings"><span class="returnvalue">GSettings</span></a> *              g_settings_new                 (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *schema</code></em>);</pre>
<p>
Creates a new <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object with a given schema.
</p>
<p>
Signals on the newly created <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object will be dispatched
via the thread-default <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> in effect at the time of the
call to <a class="link" href="GSettings.html#g-settings-new" title="g_settings_new ()"><code class="function">g_settings_new()</code></a>.  The new <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> will hold a reference
on the context.  See <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-main-context-push-thread-default"><code class="function">g_main_context_push_thread_default()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>schema</code></em> :</span></p></td>
<td>the name of the schema</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-new-with-path"></a><h3>g_settings_new_with_path ()</h3>
<pre class="programlisting"><a class="link" href="GSettings.html" title="GSettings"><span class="returnvalue">GSettings</span></a> *              g_settings_new_with_path       (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *schema</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);</pre>
<p>
Creates a new <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object with a given schema and path.
</p>
<p>
You only need to do this if you want to directly create a settings
object with a schema that doesn't have a specified path of its own.
That's quite rare.
</p>
<p>
It is a programmer error to call this function for a schema that
has an explicitly specified path.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>schema</code></em> :</span></p></td>
<td>the name of the schema</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>the path to use</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-new-with-backend"></a><h3>g_settings_new_with_backend ()</h3>
<pre class="programlisting"><a class="link" href="GSettings.html" title="GSettings"><span class="returnvalue">GSettings</span></a> *              g_settings_new_with_backend    (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *schema</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GSettingsBackend.html" title="GSettingsBackend"><span class="type">GSettingsBackend</span></a> *backend</code></em>);</pre>
<p>
Creates a new <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object with a given schema and backend.
</p>
<p>
Creating settings objects with an different backend allows accessing settings
from a database other than the usual one.  For example, it may make
sense to pass a backend corresponding to the "defaults" settings database on
the system to get a settings object that modifies the system default
settings instead of the settings for this user.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>schema</code></em> :</span></p></td>
<td>the name of the schema</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td>the <a class="link" href="GSettingsBackend.html" title="GSettingsBackend"><span class="type">GSettingsBackend</span></a> to use</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-new-with-backend-and-path"></a><h3>g_settings_new_with_backend_and_path ()</h3>
<pre class="programlisting"><a class="link" href="GSettings.html" title="GSettings"><span class="returnvalue">GSettings</span></a> *              g_settings_new_with_backend_and_path
                                                        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *schema</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GSettingsBackend.html" title="GSettingsBackend"><span class="type">GSettingsBackend</span></a> *backend</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);</pre>
<p>
Creates a new <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object with a given schema, backend and
path.
</p>
<p>
This is a mix of <a class="link" href="GSettings.html#g-settings-new-with-backend" title="g_settings_new_with_backend ()"><code class="function">g_settings_new_with_backend()</code></a> and
<a class="link" href="GSettings.html#g-settings-new-with-path" title="g_settings_new_with_path ()"><code class="function">g_settings_new_with_path()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>schema</code></em> :</span></p></td>
<td>the name of the schema</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td>the <a class="link" href="GSettingsBackend.html" title="GSettingsBackend"><span class="type">GSettingsBackend</span></a> to use</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>the path to use</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-sync"></a><h3>g_settings_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                g_settings_sync                     (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Ensures that all pending operations for the given are complete for
the default backend.
</p>
<p>
Writes made to a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> are handled asynchronously.  For this
reason, it is very unlikely that the changes have it to disk by the
time <a class="link" href="GSettings.html#g-settings-set" title="g_settings_set ()"><code class="function">g_settings_set()</code></a> returns.
</p>
<p>
This call will block until all of the writes have made it to the
backend.  Since the mainloop is not running, no change notifications
will be dispatched during this call (but some may be queued by the
time the call is done).
</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-get-value"></a><h3>g_settings_get_value ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *               g_settings_get_value           (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
<p>
Gets the value that is stored in <em class="parameter"><code>settings</code></em> for <em class="parameter"><code>key</code></em>.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't contained in the
schema for <em class="parameter"><code>settings</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to get the value for</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-set-value"></a><h3>g_settings_set_value ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_settings_set_value                (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>);</pre>
<p>
Sets <em class="parameter"><code>key</code></em> in <em class="parameter"><code>settings</code></em> to <em class="parameter"><code>value</code></em>.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't contained in the
schema for <em class="parameter"><code>settings</code></em> or for <em class="parameter"><code>value</code></em> to have the incorrect type, per
the schema.
</p>
<p>
If <em class="parameter"><code>value</code></em> is floating then this function consumes the reference.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the name of the key to set</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> of the correct type</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if setting the key succeeded,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-is-writable"></a><h3>g_settings_is_writable ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_settings_is_writable              (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Finds out if a key can be written or not
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the name of a key</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the key <em class="parameter"><code>name</code></em> is writable</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-delay"></a><h3>g_settings_delay ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                g_settings_delay                    (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>);</pre>
<p>
Changes the <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object into 'delay-apply' mode. In this
mode, changes to <em class="parameter"><code>settings</code></em> are not immediately propagated to the
backend, but kept locally until <a class="link" href="GSettings.html#g-settings-apply" title="g_settings_apply ()"><code class="function">g_settings_apply()</code></a> is called.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-apply"></a><h3>g_settings_apply ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                g_settings_apply                    (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>);</pre>
<p>
Applies any changes that have been made to the settings.  This
function does nothing unless <em class="parameter"><code>settings</code></em> is in 'delay-apply' mode;
see <a class="link" href="GSettings.html#g-settings-delay" title="g_settings_delay ()"><code class="function">g_settings_delay()</code></a>.  In the normal case settings are always
applied immediately.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> instance</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-revert"></a><h3>g_settings_revert ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                g_settings_revert                   (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>);</pre>
<p>
Reverts all non-applied changes to the settings.  This function
does nothing unless <em class="parameter"><code>settings</code></em> is in 'delay-apply' mode; see
<a class="link" href="GSettings.html#g-settings-delay" title="g_settings_delay ()"><code class="function">g_settings_delay()</code></a>.  In the normal case settings are always applied
immediately.
</p>
<p>
Change notifications will be emitted for affected keys.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> instance</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-get-has-unapplied"></a><h3>g_settings_get_has_unapplied ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_settings_get_has_unapplied        (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>);</pre>
<p>
Returns whether the <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object has any unapplied
changes.  This can only be the case if it is in 'delayed-apply' mode.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>settings</code></em> has unapplied changes</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-get-child"></a><h3>g_settings_get_child ()</h3>
<pre class="programlisting"><a class="link" href="GSettings.html" title="GSettings"><span class="returnvalue">GSettings</span></a> *              g_settings_get_child           (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Creates a 'child' settings object which has a base path of
<em class="replaceable"><code>base-path</code></em>/<em class="parameter"><code>name</code></em>, where
<em class="replaceable"><code>base-path</code></em> is the base path of <em class="parameter"><code>settings</code></em>.
</p>
<p>
The schema for the child settings object must have been declared
in the schema of <em class="parameter"><code>settings</code></em> using a <code class="sgmltag-starttag">&lt;child&gt;</code> element.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the name of the 'child' schema</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a 'child' settings object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-reset"></a><h3>g_settings_reset ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                g_settings_reset                    (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
<p>
Resets <em class="parameter"><code>key</code></em> to its default value.
</p>
<p>
This call resets the key, as much as possible, to its default value.
That might the value specified in the schema or the one set by the
administrator.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the name of a key</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-list-schemas"></a><h3>g_settings_list_schemas ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * const * g_settings_list_schemas           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Gets a list of the <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> schemas installed on the system.  The
returned list is exactly the list of schemas for which you may call
<a class="link" href="GSettings.html#g-settings-new" title="g_settings_new ()"><code class="function">g_settings_new()</code></a> without adverse effects.
</p>
<p>
This function does not list the schemas that do not provide their own
paths (ie: schemas for which you must use
<a class="link" href="GSettings.html#g-settings-new-with-path" title="g_settings_new_with_path ()"><code class="function">g_settings_new_with_path()</code></a>).  See
<a class="link" href="GSettings.html#g-settings-list-relocatable-schemas" title="g_settings_list_relocatable_schemas ()"><code class="function">g_settings_list_relocatable_schemas()</code></a> for that.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a list of <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a>
schemas that are available.  The list must not be modified or
freed. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-list-relocatable-schemas"></a><h3>g_settings_list_relocatable_schemas ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * const * g_settings_list_relocatable_schemas
                                                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Gets a list of the relocatable <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> schemas installed on the
system.  These are schemas that do not provide their own path.  It is
usual to instantiate these schemas directly, but if you want to you
can use <a class="link" href="GSettings.html#g-settings-new-with-path" title="g_settings_new_with_path ()"><code class="function">g_settings_new_with_path()</code></a> to specify the path.
</p>
<p>
The output of this function, tTaken together with the output of
<a class="link" href="GSettings.html#g-settings-list-schemas" title="g_settings_list_schemas ()"><code class="function">g_settings_list_schemas()</code></a> represents the complete list of all
installed schemas.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a list of relocatable
<a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> schemas that are available.  The list must not be
modified or freed. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.28</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-list-keys"></a><h3>g_settings_list_keys ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **                 g_settings_list_keys           (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>);</pre>
<p>
Introspects the list of keys on <em class="parameter"><code>settings</code></em>.
</p>
<p>
You should probably not be calling this function from "normal" code
(since you should already know what keys are in your schema).  This
function is intended for introspection reasons.
</p>
<p>
You should free the return value with <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a> when you are done
with it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a list of the keys on <em class="parameter"><code>settings</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-list-children"></a><h3>g_settings_list_children ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **                 g_settings_list_children       (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>);</pre>
<p>
Gets the list of children on <em class="parameter"><code>settings</code></em>.
</p>
<p>
The list is exactly the list of strings for which it is not an error
to call <a class="link" href="GSettings.html#g-settings-get-child" title="g_settings_get_child ()"><code class="function">g_settings_get_child()</code></a>.
</p>
<p>
For GSettings objects that are lists, this value can change at any
time and you should connect to the "children-changed" signal to watch
for those changes.  Note that there is a race condition here: you may
request a child after listing it only for it to have been destroyed
in the meantime.  For this reason, <a class="link" href="GSettings.html#g-settings-get-child" title="g_settings_get_child ()"><code class="function">g_settings_get_child()</code></a> may return
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> even for a child that was listed by this function.
</p>
<p>
For GSettings objects that are not lists, you should probably not be
calling this function from "normal" code (since you should already
know what children are in your schema).  This function may still be
useful there for introspection reasons, however.
</p>
<p>
You should free the return value with <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a> when you are done
with it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a list of the children on <em class="parameter"><code>settings</code></em>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-get-range"></a><h3>g_settings_get_range ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *               g_settings_get_range           (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
<p>
Queries the range of a key.
</p>
<p>
This function will return a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> that fully describes the range
of values that are valid for <em class="parameter"><code>key</code></em>.
</p>
<p>
The type of <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> returned is <code class="literal">(sv)</code>.  The
string describes the type of range restriction in effect.  The type
and meaning of the value contained in the variant depends on the
string.
</p>
<p>
If the string is <code class="literal">'type'</code> then the variant contains
an empty array.  The element type of that empty array is the expected
type of value and all values of that type are valid.
</p>
<p>
If the string is <code class="literal">'enum'</code> then the variant contains
an array enumerating the possible values.  Each item in the array is
a possible valid value and no other values are valid.
</p>
<p>
If the string is <code class="literal">'flags'</code> then the variant contains
an array.  Each item in the array is a value that may appear zero or
one times in an array to be used as the value for this key.  For
example, if the variant contained the array <code class="literal">['x',
'y']</code> then the valid values for the key would be
<code class="literal">[]</code>, <code class="literal">['x']</code>,
<code class="literal">['y']</code>, <code class="literal">['x', 'y']</code> and
<code class="literal">['y', 'x']</code>.
</p>
<p>
Finally, if the string is <code class="literal">'range'</code> then the variant
contains a pair of like-typed values -- the minimum and maximum
permissible values for this key.
</p>
<p>
This information should not be used by normal programs.  It is
considered to be a hint for introspection purposes.  Normal programs
should already know what is permitted by their own schema.  The
format may change in any way in the future -- but particularly, new
forms may be added to the possibilities described above.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't contained in the
schema for <em class="parameter"><code>settings</code></em>.
</p>
<p>
You should free the returned value with <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-unref"><code class="function">g_variant_unref()</code></a> when it is
no longer needed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to query the range of</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> describing the range</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.28</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-range-check"></a><h3>g_settings_range_check ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_settings_range_check              (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>);</pre>
<p>
Checks if the given <em class="parameter"><code>value</code></em> is of the correct type and within the
permitted range for <em class="parameter"><code>key</code></em>.
</p>
<p>
This API is not intended to be used by normal programs -- they should
already know what is permitted by their own schemas.  This API is
meant to be used by programs such as editors or commandline tools.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't contained in the
schema for <em class="parameter"><code>settings</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to check</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>the value to check</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>value</code></em> is valid for <em class="parameter"><code>key</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.28</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-get"></a><h3>g_settings_get ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                g_settings_get                      (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
                                                         <em class="parameter"><code>...</code></em>);</pre>
<p>
Gets the value that is stored at <em class="parameter"><code>key</code></em> in <em class="parameter"><code>settings</code></em>.
</p>
<p>
A convenience function that combines <a class="link" href="GSettings.html#g-settings-get-value" title="g_settings_get_value ()"><code class="function">g_settings_get_value()</code></a> with
<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-get"><code class="function">g_variant_get()</code></a>.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't contained in the
schema for <em class="parameter"><code>settings</code></em> or for the <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType"><span class="type">GVariantType</span></a> of <em class="parameter"><code>format</code></em> to mismatch
the type given in the schema.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to get the value for</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> format string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>arguments as per <em class="parameter"><code>format</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-set"></a><h3>g_settings_set ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_settings_set                      (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
                                                         <em class="parameter"><code>...</code></em>);</pre>
<p>
Sets <em class="parameter"><code>key</code></em> in <em class="parameter"><code>settings</code></em> to <em class="parameter"><code>value</code></em>.
</p>
<p>
A convenience function that combines <a class="link" href="GSettings.html#g-settings-set-value" title="g_settings_set_value ()"><code class="function">g_settings_set_value()</code></a> with
<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-new"><code class="function">g_variant_new()</code></a>.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't contained in the
schema for <em class="parameter"><code>settings</code></em> or for the <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType"><span class="type">GVariantType</span></a> of <em class="parameter"><code>format</code></em> to mismatch
the type given in the schema.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the name of the key to set</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> format string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>arguments as per <em class="parameter"><code>format</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if setting the key succeeded,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-get-boolean"></a><h3>g_settings_get_boolean ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_settings_get_boolean              (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
<p>
Gets the value that is stored at <em class="parameter"><code>key</code></em> in <em class="parameter"><code>settings</code></em>.
</p>
<p>
A convenience variant of <a class="link" href="GSettings.html#g-settings-get" title="g_settings_get ()"><code class="function">g_settings_get()</code></a> for booleans.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't specified as
having a boolean type in the schema for <em class="parameter"><code>settings</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to get the value for</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a boolean</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-set-boolean"></a><h3>g_settings_set_boolean ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_settings_set_boolean              (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>);</pre>
<p>
Sets <em class="parameter"><code>key</code></em> in <em class="parameter"><code>settings</code></em> to <em class="parameter"><code>value</code></em>.
</p>
<p>
A convenience variant of <a class="link" href="GSettings.html#g-settings-set" title="g_settings_set ()"><code class="function">g_settings_set()</code></a> for booleans.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't specified as
having a boolean type in the schema for <em class="parameter"><code>settings</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the name of the key to set</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>the value to set it to</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if setting the key succeeded,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-get-int"></a><h3>g_settings_get_int ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                g_settings_get_int                  (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
<p>
Gets the value that is stored at <em class="parameter"><code>key</code></em> in <em class="parameter"><code>settings</code></em>.
</p>
<p>
A convenience variant of <a class="link" href="GSettings.html#g-settings-get" title="g_settings_get ()"><code class="function">g_settings_get()</code></a> for 32-bit integers.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't specified as
having a int32 type in the schema for <em class="parameter"><code>settings</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to get the value for</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an integer</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-set-int"></a><h3>g_settings_set_int ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_settings_set_int                  (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);</pre>
<p>
Sets <em class="parameter"><code>key</code></em> in <em class="parameter"><code>settings</code></em> to <em class="parameter"><code>value</code></em>.
</p>
<p>
A convenience variant of <a class="link" href="GSettings.html#g-settings-set" title="g_settings_set ()"><code class="function">g_settings_set()</code></a> for 32-bit integers.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't specified as
having a int32 type in the schema for <em class="parameter"><code>settings</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the name of the key to set</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>the value to set it to</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if setting the key succeeded,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-get-double"></a><h3>g_settings_get_double ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             g_settings_get_double               (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
<p>
Gets the value that is stored at <em class="parameter"><code>key</code></em> in <em class="parameter"><code>settings</code></em>.
</p>
<p>
A convenience variant of <a class="link" href="GSettings.html#g-settings-get" title="g_settings_get ()"><code class="function">g_settings_get()</code></a> for doubles.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't specified as
having a 'double' type in the schema for <em class="parameter"><code>settings</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to get the value for</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a double</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-set-double"></a><h3>g_settings_set_double ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_settings_set_double               (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> value</code></em>);</pre>
<p>
Sets <em class="parameter"><code>key</code></em> in <em class="parameter"><code>settings</code></em> to <em class="parameter"><code>value</code></em>.
</p>
<p>
A convenience variant of <a class="link" href="GSettings.html#g-settings-set" title="g_settings_set ()"><code class="function">g_settings_set()</code></a> for doubles.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't specified as
having a 'double' type in the schema for <em class="parameter"><code>settings</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the name of the key to set</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>the value to set it to</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if setting the key succeeded,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-get-string"></a><h3>g_settings_get_string ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *                  g_settings_get_string          (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
<p>
Gets the value that is stored at <em class="parameter"><code>key</code></em> in <em class="parameter"><code>settings</code></em>.
</p>
<p>
A convenience variant of <a class="link" href="GSettings.html#g-settings-get" title="g_settings_get ()"><code class="function">g_settings_get()</code></a> for strings.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't specified as
having a string type in the schema for <em class="parameter"><code>settings</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to get the value for</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly-allocated string</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-set-string"></a><h3>g_settings_set_string ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_settings_set_string               (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
<p>
Sets <em class="parameter"><code>key</code></em> in <em class="parameter"><code>settings</code></em> to <em class="parameter"><code>value</code></em>.
</p>
<p>
A convenience variant of <a class="link" href="GSettings.html#g-settings-set" title="g_settings_set ()"><code class="function">g_settings_set()</code></a> for strings.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't specified as
having a string type in the schema for <em class="parameter"><code>settings</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the name of the key to set</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>the value to set it to</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if setting the key succeeded,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-get-strv"></a><h3>g_settings_get_strv ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **                 g_settings_get_strv            (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
<p>
A convenience variant of <a class="link" href="GSettings.html#g-settings-get" title="g_settings_get ()"><code class="function">g_settings_get()</code></a> for string arrays.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't specified as
having an array of strings type in the schema for <em class="parameter"><code>settings</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to get the value for</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a
newly-allocated, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of strings, the value that
is stored at <em class="parameter"><code>key</code></em> in <em class="parameter"><code>settings</code></em>. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-set-strv"></a><h3>g_settings_set_strv ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_settings_set_strv                 (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *const *value</code></em>);</pre>
<p>
Sets <em class="parameter"><code>key</code></em> in <em class="parameter"><code>settings</code></em> to <em class="parameter"><code>value</code></em>.
</p>
<p>
A convenience variant of <a class="link" href="GSettings.html#g-settings-set" title="g_settings_set ()"><code class="function">g_settings_set()</code></a> for string arrays.  If
<em class="parameter"><code>value</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then <em class="parameter"><code>key</code></em> is set to be the empty array.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't specified as
having an array of strings type in the schema for <em class="parameter"><code>settings</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the name of the key to set</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>the value to set it to, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if setting the key succeeded,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the key was not writable</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-get-enum"></a><h3>g_settings_get_enum ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                g_settings_get_enum                 (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
<p>
Gets the value that is stored in <em class="parameter"><code>settings</code></em> for <em class="parameter"><code>key</code></em> and converts it
to the enum value that it represents.
</p>
<p>
In order to use this function the type of the value must be a string
and it must be marked in the schema file as an enumerated type.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't contained in the
schema for <em class="parameter"><code>settings</code></em> or is not marked as an enumerated type.
</p>
<p>
If the value stored in the configuration database is not a valid
value for the enumerated type then this function will return the
default value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to get the value for</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the enum value</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-set-enum"></a><h3>g_settings_set_enum ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_settings_set_enum                 (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</code></em>);</pre>
<p>
Looks up the enumerated type nick for <em class="parameter"><code>value</code></em> and writes it to <em class="parameter"><code>key</code></em>,
within <em class="parameter"><code>settings</code></em>.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't contained in the
schema for <em class="parameter"><code>settings</code></em> or is not marked as an enumerated type, or for
<em class="parameter"><code>value</code></em> not to be a valid value for the named type.
</p>
<p>
After performing the write, accessing <em class="parameter"><code>key</code></em> directly with
<a class="link" href="GSettings.html#g-settings-get-string" title="g_settings_get_string ()"><code class="function">g_settings_get_string()</code></a> will return the 'nick' associated with
<em class="parameter"><code>value</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>a key, within <em class="parameter"><code>settings</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>an enumerated value</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if the set succeeds</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-get-flags"></a><h3>g_settings_get_flags ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               g_settings_get_flags                (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
<p>
Gets the value that is stored in <em class="parameter"><code>settings</code></em> for <em class="parameter"><code>key</code></em> and converts it
to the flags value that it represents.
</p>
<p>
In order to use this function the type of the value must be an array
of strings and it must be marked in the schema file as an flags type.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't contained in the
schema for <em class="parameter"><code>settings</code></em> or is not marked as a flags type.
</p>
<p>
If the value stored in the configuration database is not a valid
value for the flags type then this function will return the default
value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to get the value for</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the flags value</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-set-flags"></a><h3>g_settings_set_flags ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_settings_set_flags                (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> value</code></em>);</pre>
<p>
Looks up the flags type nicks for the bits specified by <em class="parameter"><code>value</code></em>, puts
them in an array of strings and writes the array to <em class="parameter"><code>key</code></em>, withing
<em class="parameter"><code>settings</code></em>.
</p>
<p>
It is a programmer error to give a <em class="parameter"><code>key</code></em> that isn't contained in the
schema for <em class="parameter"><code>settings</code></em> or is not marked as a flags type, or for <em class="parameter"><code>value</code></em>
to contain any bits that are not value for the named type.
</p>
<p>
After performing the write, accessing <em class="parameter"><code>key</code></em> directly with
<a class="link" href="GSettings.html#g-settings-get-strv" title="g_settings_get_strv ()"><code class="function">g_settings_get_strv()</code></a> will return an array of 'nicks'; one for each
bit in <em class="parameter"><code>value</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>a key, within <em class="parameter"><code>settings</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a flags value</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if the set succeeds</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GSettingsGetMapping"></a><h3>GSettingsGetMapping ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (*GSettingsGetMapping)              (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *result</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
The type of the function that is used to convert from a value stored
in a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> to a value that is useful to the application.
</p>
<p>
If the value is successfully mapped, the result should be stored at
<em class="parameter"><code>result</code></em> and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> returned.  If mapping fails (for example, if <em class="parameter"><code>value</code></em>
is not in the right format) then <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> should be returned.
</p>
<p>
If <em class="parameter"><code>value</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then it means that the mapping function is being
given a "last chance" to successfully return a valid value.  <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>
must be returned in this case.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> to map, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>the result of the mapping. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>the user data that was passed to
<a class="link" href="GSettings.html#g-settings-get-mapped" title="g_settings_get_mapped ()"><code class="function">g_settings_get_mapped()</code></a>. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the conversion succeeded, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> in case of an error</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-get-mapped"></a><h3>g_settings_get_mapped ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>            g_settings_get_mapped               (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GSettings.html#GSettingsGetMapping" title="GSettingsGetMapping ()"><span class="type">GSettingsGetMapping</span></a> mapping</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Gets the value that is stored at <em class="parameter"><code>key</code></em> in <em class="parameter"><code>settings</code></em>, subject to
application-level validation/mapping.
</p>
<p>
You should use this function when the application needs to perform
some processing on the value of the key (for example, parsing).  The
<em class="parameter"><code>mapping</code></em> function performs that processing.  If the function
indicates that the processing was unsuccessful (due to a parse error,
for example) then the mapping is tried again with another value.
</p>
<p>
This allows a robust 'fall back to defaults' behaviour to be
implemented somewhat automatically.
</p>
<p>
The first value that is tried is the user's setting for the key.  If
the mapping function fails to map this value, other values may be
tried in an unspecified order (system or site defaults, translated
schema default values, untranslated schema default values, etc).
</p>
<p>
If the mapping function fails for all possible values, one additional
attempt is made: the mapping function is called with a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value.
If the mapping function still indicates failure at this point then
the application will be aborted.
</p>
<p>
The result parameter for the <em class="parameter"><code>mapping</code></em> function is pointed to a
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> which is initially set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.  The same pointer is given
to each invocation of <em class="parameter"><code>mapping</code></em>.  The final value of that <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> is
what is returned by this function.  <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is valid; it is returned
just as any other value would be.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to get the value for</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mapping</code></em> :</span></p></td>
<td>the function to map the value in the
settings database to the value used by the application. <span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data for <em class="parameter"><code>mapping</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the result, which may be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GSettingsBindFlags"></a><h3>enum GSettingsBindFlags</h3>
<pre class="programlisting">typedef enum
{
  G_SETTINGS_BIND_DEFAULT,
  G_SETTINGS_BIND_GET            = (1&lt;&lt;0),
  G_SETTINGS_BIND_SET            = (1&lt;&lt;1),
  G_SETTINGS_BIND_NO_SENSITIVITY = (1&lt;&lt;2),
  G_SETTINGS_BIND_GET_NO_CHANGES = (1&lt;&lt;3),
  G_SETTINGS_BIND_INVERT_BOOLEAN = (1&lt;&lt;4)
} GSettingsBindFlags;
</pre>
<p>
Flags used when creating a binding. These flags determine in which
direction the binding works. The default is to synchronize in both
directions.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="G-SETTINGS-BIND-DEFAULT:CAPS"></a><span class="term"><code class="literal">G_SETTINGS_BIND_DEFAULT</code></span></p></td>
<td>Equivalent to <code class="literal">G_SETTINGS_BIND_GET|G_SETTINGS_BIND_SET</code>
</td>
</tr>
<tr>
<td><p><a name="G-SETTINGS-BIND-GET:CAPS"></a><span class="term"><code class="literal">G_SETTINGS_BIND_GET</code></span></p></td>
<td>Update the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> property when the setting changes.
    It is an error to use this flag if the property is not writable.
</td>
</tr>
<tr>
<td><p><a name="G-SETTINGS-BIND-SET:CAPS"></a><span class="term"><code class="literal">G_SETTINGS_BIND_SET</code></span></p></td>
<td>Update the setting when the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> property changes.
    It is an error to use this flag if the property is not readable.
</td>
</tr>
<tr>
<td><p><a name="G-SETTINGS-BIND-NO-SENSITIVITY:CAPS"></a><span class="term"><code class="literal">G_SETTINGS_BIND_NO_SENSITIVITY</code></span></p></td>
<td>Do not try to bind a "sensitivity" property to the writability of the setting
</td>
</tr>
<tr>
<td><p><a name="G-SETTINGS-BIND-GET-NO-CHANGES:CAPS"></a><span class="term"><code class="literal">G_SETTINGS_BIND_GET_NO_CHANGES</code></span></p></td>
<td>When set in addition to <a class="link" href="GSettings.html#G-SETTINGS-BIND-GET:CAPS"><span class="type">G_SETTINGS_BIND_GET</span></a>, set the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> property
    value initially from the setting, but do not listen for changes of the setting
</td>
</tr>
<tr>
<td><p><a name="G-SETTINGS-BIND-INVERT-BOOLEAN:CAPS"></a><span class="term"><code class="literal">G_SETTINGS_BIND_INVERT_BOOLEAN</code></span></p></td>
<td>When passed to <a class="link" href="GSettings.html#g-settings-bind" title="g_settings_bind ()"><code class="function">g_settings_bind()</code></a>, uses a pair of mapping functions that invert
    the boolean value when mapping between the setting and the property.  The setting and property must both
    be booleans.  You can not pass this flag to <a class="link" href="GSettings.html#g-settings-bind-with-mapping" title="g_settings_bind_with_mapping ()"><code class="function">g_settings_bind_with_mapping()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-bind"></a><h3>g_settings_bind ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                g_settings_bind                     (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> object</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GSettings.html#GSettingsBindFlags" title="enum GSettingsBindFlags"><span class="type">GSettingsBindFlags</span></a> flags</code></em>);</pre>
<p>
Create a binding between the <em class="parameter"><code>key</code></em> in the <em class="parameter"><code>settings</code></em> object
and the property <em class="parameter"><code>property</code></em> of <em class="parameter"><code>object</code></em>.
</p>
<p>
The binding uses the default GIO mapping functions to map
between the settings and property values. These functions
handle booleans, numeric types and string types in a
straightforward way. Use <a class="link" href="GSettings.html#g-settings-bind-with-mapping" title="g_settings_bind_with_mapping ()"><code class="function">g_settings_bind_with_mapping()</code></a> if
you need a custom mapping, or map between types that are not
supported by the default mapping functions.
</p>
<p>
Unless the <em class="parameter"><code>flags</code></em> include <a class="link" href="GSettings.html#G-SETTINGS-BIND-NO-SENSITIVITY:CAPS"><code class="literal">G_SETTINGS_BIND_NO_SENSITIVITY</code></a>, this
function also establishes a binding between the writability of
<em class="parameter"><code>key</code></em> and the "sensitive" property of <em class="parameter"><code>object</code></em> (if <em class="parameter"><code>object</code></em> has
a boolean property by that name). See <a class="link" href="GSettings.html#g-settings-bind-writable" title="g_settings_bind_writable ()"><code class="function">g_settings_bind_writable()</code></a>
for more details about writable bindings.
</p>
<p>
Note that the lifecycle of the binding is tied to the object,
and that you can have only one binding per object property.
If you bind the same property twice on the same object, the second
binding overrides the first one.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to bind</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>. <span class="annotation">[<acronym title="Override the parsed C type with given type"><span class="acronym">type</span></acronym> GObject.Object]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>the name of the property to bind</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>flags for the binding</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-bind-with-mapping"></a><h3>g_settings_bind_with_mapping ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                g_settings_bind_with_mapping        (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> object</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GSettings.html#GSettingsBindFlags" title="enum GSettingsBindFlags"><span class="type">GSettingsBindFlags</span></a> flags</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GSettings.html#GSettingsBindGetMapping" title="GSettingsBindGetMapping ()"><span class="type">GSettingsBindGetMapping</span></a> get_mapping</code></em>,
                                                         <em class="parameter"><code><a class="link" href="GSettings.html#GSettingsBindSetMapping" title="GSettingsBindSetMapping ()"><span class="type">GSettingsBindSetMapping</span></a> set_mapping</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);</pre>
<p>
Create a binding between the <em class="parameter"><code>key</code></em> in the <em class="parameter"><code>settings</code></em> object
and the property <em class="parameter"><code>property</code></em> of <em class="parameter"><code>object</code></em>.
</p>
<p>
The binding uses the provided mapping functions to map between
settings and property values.
</p>
<p>
Note that the lifecycle of the binding is tied to the object,
and that you can have only one binding per object property.
If you bind the same property twice on the same object, the second
binding overrides the first one.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to bind</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>. <span class="annotation">[<acronym title="Override the parsed C type with given type"><span class="acronym">type</span></acronym> GObject.Object]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>the name of the property to bind</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>flags for the binding</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>get_mapping</code></em> :</span></p></td>
<td>a function that gets called to convert values
from <em class="parameter"><code>settings</code></em> to <em class="parameter"><code>object</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default GIO mapping</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>set_mapping</code></em> :</span></p></td>
<td>a function that gets called to convert values
from <em class="parameter"><code>object</code></em> to <em class="parameter"><code>settings</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default GIO mapping</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data that gets passed to <em class="parameter"><code>get_mapping</code></em> and <em class="parameter"><code>set_mapping</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> function for <em class="parameter"><code>user_data</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-bind-writable"></a><h3>g_settings_bind_writable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                g_settings_bind_writable            (<em class="parameter"><code><a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> object</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> inverted</code></em>);</pre>
<p>
Create a binding between the writability of <em class="parameter"><code>key</code></em> in the
<em class="parameter"><code>settings</code></em> object and the property <em class="parameter"><code>property</code></em> of <em class="parameter"><code>object</code></em>.
The property must be boolean; "sensitive" or "visible"
properties of widgets are the most likely candidates.
</p>
<p>
Writable bindings are always uni-directional; changes of the
writability of the setting will be propagated to the object
property, not the other way.
</p>
<p>
When the <em class="parameter"><code>inverted</code></em> argument is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the binding inverts the
value as it passes from the setting to the object, i.e. <em class="parameter"><code>property</code></em>
will be set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the key is <span class="emphasis"><em>not</em></span>
writable.
</p>
<p>
Note that the lifecycle of the binding is tied to the object,
and that you can have only one binding per object property.
If you bind the same property twice on the same object, the second
binding overrides the first one.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>a <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to bind</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>. <span class="annotation">[<acronym title="Override the parsed C type with given type"><span class="acronym">type</span></acronym> GObject.Object]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>the name of a boolean property to bind</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>inverted</code></em> :</span></p></td>
<td>whether to 'invert' the value</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="g-settings-unbind"></a><h3>g_settings_unbind ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                g_settings_unbind                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> object</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property</code></em>);</pre>
<p>
Removes an existing binding for <em class="parameter"><code>property</code></em> on <em class="parameter"><code>object</code></em>.
</p>
<p>
Note that bindings are automatically removed when the
object is finalized, so it is rarely necessary to call this
function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>the object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td>
<td>the property whose binding is removed</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="GSettingsBindSetMapping"></a><h3>GSettingsBindSetMapping ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *          (*GSettingsBindSetMapping)          (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType"><span class="type">GVariantType</span></a> *expected_type</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
The type for the function that is used to convert an object property
value to a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> for storing it in <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> containing the property value to map</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>expected_type</code></em> :</span></p></td>
<td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#GVariantType"><span class="type">GVariantType</span></a> to create</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data that was specified when the binding was created</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> holding the data from <em class="parameter"><code>value</code></em>,
or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case of an error</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GSettingsBindGetMapping"></a><h3>GSettingsBindGetMapping ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (*GSettingsBindGetMapping)          (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
The type for the function that is used to convert from <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> to
an object property. The <em class="parameter"><code>value</code></em> is already initialized to hold values
of the appropriate type.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>return location for the property value</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td>
<td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data that was specified when the binding was created</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the conversion succeeded, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> in case of an error</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GSettings.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GSettings--backend"></a><h3>The <code class="literal">"backend"</code> property</h3>
<pre class="programlisting">  "backend"                  <a class="link" href="GSettingsBackend.html" title="GSettingsBackend"><span class="type">GSettingsBackend</span></a>*     : Read / Write / Construct Only</pre>
<p>The GSettingsBackend for this settings object.</p>
</div>
<hr>
<div class="refsect2">
<a name="GSettings--delay-apply"></a><h3>The <code class="literal">"delay-apply"</code> property</h3>
<pre class="programlisting">  "delay-apply"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read</pre>
<p>
Whether the <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object is in 'delay-apply' mode. See
<a class="link" href="GSettings.html#g-settings-delay" title="g_settings_delay ()"><code class="function">g_settings_delay()</code></a> for details.
</p>
<p>Default value: FALSE</p>
<p class="since">Since 2.28</p>
</div>
<hr>
<div class="refsect2">
<a name="GSettings--has-unapplied"></a><h3>The <code class="literal">"has-unapplied"</code> property</h3>
<pre class="programlisting">  "has-unapplied"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read</pre>
<p>
If this property is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object has outstanding
changes that will be applied when <a class="link" href="GSettings.html#g-settings-apply" title="g_settings_apply ()"><code class="function">g_settings_apply()</code></a> is called.
</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GSettings--path"></a><h3>The <code class="literal">"path"</code> property</h3>
<pre class="programlisting">  "path"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
<p>
The path within the backend where the settings are stored.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GSettings--schema"></a><h3>The <code class="literal">"schema"</code> property</h3>
<pre class="programlisting">  "schema"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
<p>
The name of the schema that describes the types of keys
for this <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object.
</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="GSettings.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GSettings-change-event"></a><h3>The <code class="literal">"change-event"</code> signal</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   keys,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>       n_keys,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
The "change-event" signal is emitted once per change event that
affects this settings object.  You should connect to this signal
only if you are interested in viewing groups of changes before they
are split out into multiple emissions of the "changed" signal.
For most use cases it is more appropriate to use the "changed" signal.
</p>
<p>
In the event that the change event applies to one or more specified
keys, <em class="parameter"><code>keys</code></em> will be an array of <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> of length <em class="parameter"><code>n_keys</code></em>.  In the
event that the change event applies to the <a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> object as a
whole (ie: potentially every key has been changed) then <em class="parameter"><code>keys</code></em> will
be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and <em class="parameter"><code>n_keys</code></em> will be 0.
</p>
<p>
The default handler for this signal invokes the "changed" signal
for each affected key.  If any other connected handler returns
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> then this default functionality will be supressed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>the object on which the signal was emitted</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>keys</code></em> :</span></p></td>
<td>an array of <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a>s for the changed keys, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_keys][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GQuark][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_keys</code></em> :</span></p></td>
<td>the length of the <em class="parameter"><code>keys</code></em> array, or 0</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to stop other handlers from being invoked for the
event. FALSE to propagate the event further.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GSettings-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>     *key,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a></pre>
<p>
The "changed" signal is emitted when a key has potentially changed.
You should call one of the <a class="link" href="GSettings.html#g-settings-get" title="g_settings_get ()"><code class="function">g_settings_get()</code></a> calls to check the new
value.
</p>
<p>
This signal supports detailed connections.  You can connect to the
detailed signal "changed::x" in order to only receive callbacks
when key "x" changes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>the object on which the signal was emitted</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the name of the key that changed</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GSettings-writable-change-event"></a><h3>The <code class="literal">"writable-change-event"</code> signal</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>      key,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
The "writable-change-event" signal is emitted once per writability
change event that affects this settings object.  You should connect
to this signal if you are interested in viewing groups of changes
before they are split out into multiple emissions of the
"writable-changed" signal.  For most use cases it is more
appropriate to use the "writable-changed" signal.
</p>
<p>
In the event that the writability change applies only to a single
key, <em class="parameter"><code>key</code></em> will be set to the <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> for that key.  In the event
that the writability change affects the entire settings object,
<em class="parameter"><code>key</code></em> will be 0.
</p>
<p>
The default handler for this signal invokes the "writable-changed"
and "changed" signals for each affected key.  This is done because
changes in writability might also imply changes in value (if for
example, a new mandatory setting is introduced).  If any other
connected handler returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> then this default functionality
will be supressed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>the object on which the signal was emitted</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the quark of the key, or 0</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>returns</code></em> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to stop other handlers from being invoked for the
event. FALSE to propagate the event further.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GSettings-writable-changed"></a><h3>The <code class="literal">"writable-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GSettings.html" title="GSettings"><span class="type">GSettings</span></a> *settings,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>     *key,
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-DETAILED:CAPS"><code class="literal">Has Details</code></a></pre>
<p>
The "writable-changed" signal is emitted when the writability of a
key has potentially changed.  You should call
<a class="link" href="GSettings.html#g-settings-is-writable" title="g_settings_is_writable ()"><code class="function">g_settings_is_writable()</code></a> in order to determine the new status.
</p>
<p>
This signal supports detailed connections.  You can connect to the
detailed signal "writable-changed::x" in order to only receive
callbacks when the writability of "x" changes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>settings</code></em> :</span></p></td>
<td>the object on which the signal was emitted</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.17</div>
</body>
</html>